<!--

     Licensed to the Apache Software Foundation (ASF) under one
     or more contributor license agreements.  See the NOTICE file
     distributed with this work for additional information
     regarding copyright ownership.  The ASF licenses this file
     to you under the Apache License, Version 2.0 (the
     "License"); you may not use this file except in compliance
     with the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

     Unless required by applicable law or agreed to in writing,
     software distributed under the License is distributed on an
     "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     KIND, either express or implied.  See the License for the
     specific language governing permissions and limitations
     under the License.

-->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- **************************************************************** -->
<!-- *  PLEASE KEEP COMPLICATED EXPRESSIONS OUT OF THESE TEMPLATES, * -->
<!-- *  i.e. only iterate & print data where possible. Thanks, Jez. * -->
<!-- **************************************************************** -->

<html>
<head>
    <!-- Generated by groovydoc (2.4.5) on Mon Sep 12 08:35:18 CEST 2016 -->
    <title>HttpEndpoint (Groovy Documentation)</title>
    <meta name="date" content="2016-09-12">
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <link href="../../../../../groovy.ico" type="image/x-icon" rel="shortcut icon">
    <link href="../../../../../groovy.ico" type="image/x-icon" rel="icon">
    <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">

<body class="center">
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
    parent.document.title="HttpEndpoint (Groovy Documentation)";
}
//-->
</script>
<noscript>
    <div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
    <!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
    <!--   -->
</a>
    <ul class="navList" title="Navigation">
        <li><a href="../../../../../overview-summary.html">Overview</a></li>
        <li><a href="package-summary.html">Package</a></li>
        <li class="navBarCell1Rev">Class</li>
        <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
        <li><a href="../../../../../index-all.html">Index</a></li>
        <li><a href="../../../../../help-doc.html">Help</a></li>
    </ul>
</div>

<div class="subNav">
    <div>
        <ul class="navList">
            <li><a href="../../../../../index.html?io/vertx/groovy/servicediscovery/types/HttpEndpoint" target="_top">Frames</a></li>
            <li><a href="HttpEndpoint.html" target="_top">No Frames</a></li>
        </ul>
    </div>
    <div>
        <ul class="subNavList">
            <li>Summary:&nbsp;</li>
            Nested&nbsp;&nbsp;&nbsp;Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#constructor_summary">Constructor</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#method_summary">Method</a></li>&nbsp;&nbsp;&nbsp;
        </ul>
        <ul class="subNavList">
            <li>&nbsp;|&nbsp;Detail:&nbsp;</li>
            Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#constructor_detail">Constructor</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#method_detail">Method</a></li>&nbsp;&nbsp;&nbsp;
        </ul>
    </div>
    <a name="skip-navbar_top">
        <!--   -->
    </a></div>
<!-- ========= END OF TOP NAVBAR ========= -->

<!-- ======== START OF CLASS DATA ======== -->
<div class="header">

    <div class="subTitle">Package: <strong>io.vertx.groovy.servicediscovery.types</strong></div>

    <h2 title="[Groovy] Class HttpEndpoint" class="title">[Groovy] Class HttpEndpoint</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><ul class="inheritance"></ul></li><li>io.vertx.groovy.servicediscovery.types.HttpEndpoint
</ul>
<div class="description">
    <ul class="blockList">
        <li class="blockList">



    <p>  for HTTP endpoint (REST api).
 Consumers receive a HTTP client configured with the host and port of the endpoint.
</p>

          </li>
    </ul>
</div>

<div class="summary">
    <ul class="blockList">
        <li class="blockList">
        <!-- =========== NESTED CLASS SUMMARY =========== -->
        

        <!-- =========== ENUM CONSTANT SUMMARY =========== -->
        
        <!-- =========== FIELD SUMMARY =========== -->
        

        <!-- =========== PROPERTY SUMMARY =========== -->
        

        <!-- =========== ELEMENT SUMMARY =========== -->
        

        
        <!-- ======== CONSTRUCTOR SUMMARY ======== -->
        <ul class="blockList">
                <li class="blockList"><a name="constructor_summary"><!--   --></a>
                    <h3>Constructor Summary</h3>
                    <ul class="blockList">
                    <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructors Summary table">
                        <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
                        <tr>
                            <th class="colFirst" scope="col">Constructor and description</th>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst">
                                <code><a href="#HttpEndpoint(java.lang.Object)">HttpEndpoint</a></strong>
                                (java.lang.Object delegate)</code><br></td>
                        </tr>
                        
                    </table>
                   </ul>
              </li>
        </ul>
        

        
        <!-- ========== METHOD SUMMARY =========== -->
        <ul class="blockList">
            
            <li class="blockList"><a name="method_summary"><!--   --></a>
                    <h3>Methods Summary</h3>
                    <ul class="blockList">
                    <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Methods Summary table">
                        <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
                        <tr>
                            <th class="colFirst" scope="col">Type</th>
                            <th class="colLast" scope="col">Name and description</th>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code>static&nbsp;java.util.Map&lt;java.lang.String, java.lang.Object&gt;</strong></code></td>
                            <td class="colLast"><code><strong><a href="#createRecord(java.lang.String, java.lang.String, int, java.lang.String, Map<String, Object>)">createRecord</a></strong>(java.lang.String name, java.lang.String host, int port, java.lang.String root, java.util.Map&lt;java.lang.String, java.lang.Object&gt; metadata)</code><br>Convenient method to create a record for a HTTP endpoint.</td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code>static&nbsp;java.util.Map&lt;java.lang.String, java.lang.Object&gt;</strong></code></td>
                            <td class="colLast"><code><strong><a href="#createRecord(java.lang.String, boolean, java.lang.String, int, java.lang.String, Map<String, Object>)">createRecord</a></strong>(java.lang.String name, boolean ssl, java.lang.String host, int port, java.lang.String root, java.util.Map&lt;java.lang.String, java.lang.Object&gt; metadata)</code><br>Same as <a href='../../../../../io/vertx/groovy/servicediscovery/types/HttpEndpoint.html#createRecord' title='HttpEndpoint.createRecord'>HttpEndpoint.createRecord</a> but let you configure whether or not the
 service is using <code>https</code>.</td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code>static&nbsp;java.util.Map&lt;java.lang.String, java.lang.Object&gt;</strong></code></td>
                            <td class="colLast"><code><strong><a href="#createRecord(java.lang.String, java.lang.String, int, java.lang.String)">createRecord</a></strong>(java.lang.String name, java.lang.String host, int port, java.lang.String root)</code><br>Same as <a href='../../../../../io/vertx/groovy/servicediscovery/types/HttpEndpoint.html#createRecord' title='HttpEndpoint.createRecord'>HttpEndpoint.createRecord</a> but without metadata.</td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code>static&nbsp;java.util.Map&lt;java.lang.String, java.lang.Object&gt;</strong></code></td>
                            <td class="colLast"><code><strong><a href="#createRecord(java.lang.String, java.lang.String)">createRecord</a></strong>(java.lang.String name, java.lang.String host)</code><br>Same as <a href='../../../../../io/vertx/groovy/servicediscovery/types/HttpEndpoint.html#createRecord' title='HttpEndpoint.createRecord'>HttpEndpoint.createRecord</a> but without metadata, using the port 80
 and using "/" as root.</td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code>static&nbsp;void</strong></code></td>
                            <td class="colLast"><code><strong><a href="#getClient(io.vertx.groovy.servicediscovery.ServiceDiscovery, Map<String, Object>, Handler<AsyncResult<HttpClient>>)">getClient</a></strong>(<a href='../../../../../io/vertx/groovy/servicediscovery/ServiceDiscovery.html'>ServiceDiscovery</a> discovery, java.util.Map&lt;java.lang.String, java.lang.Object&gt; filter, io.vertx.core.Handler&lt;io.vertx.core.AsyncResult&lt;<a href='../../../../../io/vertx/groovy/core/http/HttpClient.html' title='HttpClient'>HttpClient</a>&gt;&gt; resultHandler)</code><br>Convenient method that looks for a HTTP endpoint and provides the configured . </td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code>java.lang.Object</strong></code></td>
                            <td class="colLast"><code><strong><a href="#getDelegate()">getDelegate</a></strong>()</code><br></td>
                        </tr>
                        
                    </table>
                   </ul>
              </li>
            
            <li class="blockList"><a name="method_summary"><!--   --></a>
                    <h3>Inherited Methods Summary</h3>
                    <ul class="blockList">
                    <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Inherited Methods Summary table">
                        <caption><span>Inherited Methods</span><span class="tabEnd">&nbsp;</span></caption>
                        <tr>
                            <th class="colFirst" scope="col">Methods inherited from class</th>
                            <th class="colLast" scope="col">Name</th>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code>class java.lang.Object</strong></code></td>
                            <td class="colLast"><code>java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()</code></td>
                        </tr>
                    </table>
                   </ul>
              </li>
                
        </ul>
        
    </li>
    </ul>
</div>

<div class="details">
    <ul class="blockList">
        <li class="blockList">
           

            

            

            

            
            <!-- =========== CONSTRUCTOR DETAIL =========== -->
            <ul class="blockList">
                <li class="blockList"><a name="constructor_detail">
                    <!--   -->
                </a>
                    <h3>Constructor Detail</h3>
                    
                        <a name="HttpEndpoint(java.lang.Object)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><strong>HttpEndpoint</strong>(java.lang.Object delegate)</h4>
                                <p></p>
                            </li>
                        </ul>
                    
                </li>
            </ul>
            


            
            <!-- =========== METHOD DETAIL =========== -->
            <ul class="blockList">
                <li class="blockList"><a name="method_detail">
                    <!--   -->
                </a>
                    <h3>Method Detail</h3>
                    
                        <a name="createRecord(java.lang.String, java.lang.String, int, java.lang.String, Map<String, Object>)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>static&nbsp;java.util.Map&lt;java.lang.String, java.lang.Object&gt; <strong>createRecord</strong>(java.lang.String name, java.lang.String host, int port, java.lang.String root, java.util.Map&lt;java.lang.String, java.lang.Object&gt; metadata)</h4>
                                <p> Convenient method to create a record for a HTTP endpoint.
   <DL><DT><B>Returns:</B></DT><DD>the created record (see <a href="../../../../../../../cheatsheet/Record.html">Record</a>)</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>name</code> -  the service name</DD><DD><code>host</code> -  the host (IP or DNS name), it must be the _public_ IP / name</DD><DD><code>port</code> -  the port, it must be the _public_ port</DD><DD><code>root</code> -  the path of the service, "/" if not set</DD><DD><code>metadata</code> -  additional metadata</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="createRecord(java.lang.String, boolean, java.lang.String, int, java.lang.String, Map<String, Object>)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>static&nbsp;java.util.Map&lt;java.lang.String, java.lang.Object&gt; <strong>createRecord</strong>(java.lang.String name, boolean ssl, java.lang.String host, int port, java.lang.String root, java.util.Map&lt;java.lang.String, java.lang.Object&gt; metadata)</h4>
                                <p> Same as <a href='../../../../../io/vertx/groovy/servicediscovery/types/HttpEndpoint.html#createRecord' title='HttpEndpoint.createRecord'>HttpEndpoint.createRecord</a> but let you configure whether or not the
 service is using <code>https</code>.
   <DL><DT><B>Returns:</B></DT><DD>the created record (see <a href="../../../../../../../cheatsheet/Record.html">Record</a>)</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>name</code> -  the service name</DD><DD><code>ssl</code> -  whether or not the service is using HTTPS</DD><DD><code>host</code> -  the host (IP or DNS name), it must be the _public_ IP / name</DD><DD><code>port</code> -  the port, it must be the _public_ port</DD><DD><code>root</code> -  the path of the service, "/" if not set</DD><DD><code>metadata</code> -  additional metadata</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="createRecord(java.lang.String, java.lang.String, int, java.lang.String)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>static&nbsp;java.util.Map&lt;java.lang.String, java.lang.Object&gt; <strong>createRecord</strong>(java.lang.String name, java.lang.String host, int port, java.lang.String root)</h4>
                                <p> Same as <a href='../../../../../io/vertx/groovy/servicediscovery/types/HttpEndpoint.html#createRecord' title='HttpEndpoint.createRecord'>HttpEndpoint.createRecord</a> but without metadata.
   <DL><DT><B>Returns:</B></DT><DD>the created record (see <a href="../../../../../../../cheatsheet/Record.html">Record</a>)</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>name</code> -  the service name</DD><DD><code>host</code> -  the host, must be public</DD><DD><code>port</code> -  the port</DD><DD><code>root</code> -  the root, if not set "/" is used</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="createRecord(java.lang.String, java.lang.String)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>static&nbsp;java.util.Map&lt;java.lang.String, java.lang.Object&gt; <strong>createRecord</strong>(java.lang.String name, java.lang.String host)</h4>
                                <p> Same as <a href='../../../../../io/vertx/groovy/servicediscovery/types/HttpEndpoint.html#createRecord' title='HttpEndpoint.createRecord'>HttpEndpoint.createRecord</a> but without metadata, using the port 80
 and using "/" as root.
   <DL><DT><B>Returns:</B></DT><DD>the created record (see <a href="../../../../../../../cheatsheet/Record.html">Record</a>)</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>name</code> -  the name</DD><DD><code>host</code> -  the host</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="getClient(io.vertx.groovy.servicediscovery.ServiceDiscovery, Map<String, Object>, Handler<AsyncResult<HttpClient>>)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>static&nbsp;void <strong>getClient</strong>(<a href='../../../../../io/vertx/groovy/servicediscovery/ServiceDiscovery.html'>ServiceDiscovery</a> discovery, java.util.Map&lt;java.lang.String, java.lang.Object&gt; filter, io.vertx.core.Handler&lt;io.vertx.core.AsyncResult&lt;<a href='../../../../../io/vertx/groovy/core/http/HttpClient.html' title='HttpClient'>HttpClient</a>&gt;&gt; resultHandler)</h4>
                                <p> Convenient method that looks for a HTTP endpoint and provides the configured . The async result
 is marked as failed is there are no matching services, or if the lookup fails.
   <DL><DT><B>Parameters:</B></DT><DD><code>discovery</code> -  The service discovery instance</DD><DD><code>filter</code> -  The filter, optional</DD><DD><code>resultHandler</code> -  The result handler</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="getDelegate()"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>java.lang.Object <strong>getDelegate</strong>()</h4>
                                <p></p>
                            </li>
                        </ul>
                    
                </li>
            </ul>
            
        </li>
    </ul>
</div>

<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
    <!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
    <!--   -->
</a>
    <ul class="navList" title="Navigation">
        <li><a href="../../../../../overview-summary.html">Overview</a></li>
        <li><a href="package-summary.html">Package</a></li>
        <li class="navBarCell1Rev">Class</li>
        <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
        <li><a href="../../../../../index-all.html">Index</a></li>
        <li><a href="../../../../../help-doc.html">Help</a></li>
    </ul>
</div>

<div class="subNav">
    <div>
        <ul class="navList">
            <li><a href="../../../../../index.html?io/vertx/groovy/servicediscovery/types/HttpEndpoint" target="_top">Frames</a></li>
            <li><a href="HttpEndpoint.html" target="_top">No Frames</a></li>
        </ul>
    </div>
    <div>
        <ul class="subNavList">
            <li>Summary:&nbsp;</li>
            Nested&nbsp;&nbsp;&nbsp;Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#constructor_summary">Constructor</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#method_summary">Method</a></li>&nbsp;&nbsp;&nbsp;
        </ul>
        <ul class="subNavList">
            <li>&nbsp;|&nbsp;Detail:&nbsp;</li>
            Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#constructor_detail">Constructor</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#method_detail">Method</a></li>&nbsp;&nbsp;&nbsp;
        </ul>
    </div>
    <p>Groovy Documentation</p>
    <a name="skip-navbar_bottom">
        <!--   -->
    </a>
    </div>
</div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>